Class com.symantec.itools.vcafe.openapi.options.EnvironmentEditingOptions
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.options.EnvironmentEditingOptions

Object
   |
   +----com.symantec.itools.vcafe.openapi.options.EnvironmentEditingOptions

public abstract class EnvironmentEditingOptions
extends Object
The API used to represent and access the editing-related options of the Visual Cafe environment. These options that appear in the "Editing" tab in the Environment Options dialog.

Use EnvironmentOptionSet.getEditingOptions() to get an instance of this object.

Version:
1.0
Author:
Symantec Internet Tools Division
Since:
VCafe 3.0
See Also:
getEnvironmentOptionSet, getEditingOptions

Variable Index

 o INSERT_BLOCK
Indicates the text cursor will be a block when the editor is in insert mode.
 o INSERT_UNDERLINE
Indicates the text cursor will be an underline when the editor is in insert mode.
 o INSERT_VERTICALBAR
Indicates the text cursor will be a vertical bar when the editor is in insert mode (default).
 o MULTIPLESELECTION_CONFIRM
Indicates the you can select (and change) multiple classes in the Class Browser and Hierarchy Editor, but changes to multiple selections require confirmation (default).
 o MULTIPLESELECTION_NO
Indicates the you cannot select (and change) multiple classes in the Class Browser and Hierarchy Editor.
 o MULTIPLESELECTION_YES
Indicates the you can select (and change) multiple classes in the Class Browser and Hierarchy Editor.
 o OVERWRITE_BLOCK
Indicates the text cursor will be a block when the editor is in overwrite mode (default).
 o OVERWRITE_UNDERLINE
Indicates the text cursor will be an underline when the editor is in overwrite mode.
 o OVERWRITE_VERTICALBAR
Indicates the text cursor will be a vertical bar when the editor is in overwrite mode.

Constructor Index

 o com.symantec.itools.vcafe.openapi.options.EnvironmentEditingOptions()

Method Index

 o getInsert()
Gets the type of text cursor displayed when the editor is in insert mode.
 o getMultipleSelection()
Gets the multiple selection mode of the Class Browser and Hierarchy Editor.
 o getOverwrite()
Gets the type of text cursor displayed when the editor is in overwrite mode.
 o isAutomaticallyShowCodeHelper()
Determines whether the code helper is displayed in source windows and panes.
 o isConfirmDeleteMember()
Determines whether the Class Browser and Hierarchy Editor will ask for confirmation before deleting a class member.
 o isConfirmInheritanceChange()
Determines whether the Class Browser and Hierarchy Editor will ask for confirmation before changing the inheritance of a class.
 o isHilightSyntaxErrorsWhileEditing()
Determines whether syntax errors are highlighted while editing source.
 o isInsertBlink()
Determines whether the text cursor will blink while the editor is in insert mode.
 o isOverwriteBlink()
Determines whether the text cursor will blink while the editor is in overwrite mode.
 o isShowHorizontalScrollBars()
Determines whether a horizontal scroll bar is shown at the bottom of source windows and panes.

Variables

 o INSERT_BLOCK
public static final int INSERT_BLOCK
Indicates the text cursor will be a block when the editor is in insert mode.

See Also:
getInsert
 o INSERT_UNDERLINE
public static final int INSERT_UNDERLINE
Indicates the text cursor will be an underline when the editor is in insert mode.

See Also:
getInsert
 o INSERT_VERTICALBAR
public static final int INSERT_VERTICALBAR
Indicates the text cursor will be a vertical bar when the editor is in insert mode (default).

See Also:
getInsert
 o MULTIPLESELECTION_CONFIRM
public static final int MULTIPLESELECTION_CONFIRM
Indicates the you can select (and change) multiple classes in the Class Browser and Hierarchy Editor, but changes to multiple selections require confirmation (default).

See Also:
getMultipleSelection
 o MULTIPLESELECTION_NO
public static final int MULTIPLESELECTION_NO
Indicates the you cannot select (and change) multiple classes in the Class Browser and Hierarchy Editor.

See Also:
getMultipleSelection
 o MULTIPLESELECTION_YES
public static final int MULTIPLESELECTION_YES
Indicates the you can select (and change) multiple classes in the Class Browser and Hierarchy Editor.

See Also:
getMultipleSelection
 o OVERWRITE_BLOCK
public static final int OVERWRITE_BLOCK
Indicates the text cursor will be a block when the editor is in overwrite mode (default).

See Also:
getOverwrite
 o OVERWRITE_UNDERLINE
public static final int OVERWRITE_UNDERLINE
Indicates the text cursor will be an underline when the editor is in overwrite mode.

See Also:
getOverwrite
 o OVERWRITE_VERTICALBAR
public static final int OVERWRITE_VERTICALBAR
Indicates the text cursor will be a vertical bar when the editor is in overwrite mode.

See Also:
getOverwrite

Constructors

 o EnvironmentEditingOptions
public EnvironmentEditingOptions()

Methods

 o getInsert
public abstract int getInsert()
Gets the type of text cursor displayed when the editor is in insert mode.

The "Insert" key toggles between insert and overwrite modes.

Returns:
One of:
  • INSERT_BLOCK - a block text cursor,
  • INSERT_UNDERLINE - an underline text cursor, or
  • INSERT_VERTICALBAR - a vertical bar text cursor (default).
 o getMultipleSelection
public abstract int getMultipleSelection()
Gets the multiple selection mode of the Class Browser and Hierarchy Editor.

Returns:
One of:
  • MULTIPLESELECTION_NO - multiple selections not allowed,
  • MULTIPLESELECTION_YES - multiple selections allowed, or
  • MULTIPLESELECTION_CONFIRM - multiple selections allowed; changes require confirmation (default).
 o getOverwrite
public abstract int getOverwrite()
Gets the type of text cursor displayed when the editor is in overwrite mode.

The "Insert" key toggles between insert and overwrite modes.

Returns:
One of:
  • OVERWRITE_BLOCK - a block text cursor (default),
  • OVERWRITE_UNDERLINE - an underline text cursor, or
  • OVERWRITE_VERTICALBAR - a vertical bar text cursor.
 o isAutomaticallyShowCodeHelper
public abstract boolean isAutomaticallyShowCodeHelper()
Determines whether the code helper is displayed in source windows and panes.

The code helper is a "smart" list of identifiers that popus up at opportune times, allowing quick entry of commonly used items.

The default is true.

Returns:
true if the code helper is shown, false otherwise.
 o isConfirmDeleteMember
public abstract boolean isConfirmDeleteMember()
Determines whether the Class Browser and Hierarchy Editor will ask for confirmation before deleting a class member.

The default is true.

Returns:
true if deletions are confirmed, false otherwise.
 o isConfirmInheritanceChange
public abstract boolean isConfirmInheritanceChange()
Determines whether the Class Browser and Hierarchy Editor will ask for confirmation before changing the inheritance of a class.

The default is true.

Returns:
true if inheritance changes are confirmed, false otherwise.
 o isHilightSyntaxErrorsWhileEditing
public abstract boolean isHilightSyntaxErrorsWhileEditing()
Determines whether syntax errors are highlighted while editing source.

The default is true.

Returns:
true if syntax errors are highlighted, false otherwise.
 o isInsertBlink
public abstract boolean isInsertBlink()
Determines whether the text cursor will blink while the editor is in insert mode.

The default is true.

Returns:
true if the cursor will blink, false otherwise.
 o isOverwriteBlink
public abstract boolean isOverwriteBlink()
Determines whether the text cursor will blink while the editor is in overwrite mode.

The default is true.

Returns:
true if the cursor will blink, false otherwise.
 o isShowHorizontalScrollBars
public abstract boolean isShowHorizontalScrollBars()
Determines whether a horizontal scroll bar is shown at the bottom of source windows and panes.

The default is true.

Returns:
true if a horizontal scroll bar is shown, false otherwise.

All Packages  Class Hierarchy  This Package  Previous  Next  Index